Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix types of sub-messages in class declaration #1952

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

indutny-signal
Copy link

Prior to this change the class' jsdoc comments would state the type of the class properties that encode sub-messages as:

/**
 * Sent editMessage.
 * @member {proto.IEditMessage|null|undefined} editMessage * @memberof proto.SyncMessage.Sent * @instance */

After the change:

/**
 * Sent editMessage.
 * @member {proto.EditMessage|null|undefined} editMessage * @memberof proto.SyncMessage.Sent * @instance */

The difference is that the latter specifices the class type and not the interface which better reflects the actual type returned by .decode() method.

This is a breaking change because constructing the class would now require providing the class instances and not interfaces

Prior to this change the class' jsdoc comments would state the type of
the class properties that encode sub-messages as:

    /**
     * Sent editMessage.
     * @member {proto.IEditMessage|null|undefined} editMessage
     * @memberof proto.SyncMessage.Sent
     * @instance
     */

After the change:

    /**
     * Sent editMessage.
     * @member {proto.EditMessage|null|undefined} editMessage
     * @memberof proto.SyncMessage.Sent
     * @instance
     */

The difference is that the latter specifices the class type and not the
interface which better reflects the actual type returned by `.decode()`
method.

This is a breaking change because constructing the class would now
require providing the class instances and not interfaces
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant